PostgreSQL 8.0.0 documentation for the MacOS X Help Viewer

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

I've packaged the PostgreSQL 8.0.0 documentation for the MacOS X Help Viewer[1].

It's downloadable at:

    <http://homepage.mac.com/jimini/>


== Installation ==

1. uncompress the zip file;
2. drop the PostgreSQL 8.0.0 Documentation.help file into the
/Library/Documentation/Help folder.

Open the file by double-clicking it.

You can also access it from the Finder:

1. select Mac Help from the Help menu;
2. select PostgreSQL 8.0.0 Documentation from the Library menu.


== To do ==

This is a (0.1 !) manual packaging and some pieces are missing right now:

- - the Help Viewer index;
- - the list of figures, tables and examples pages;
- - the Finder icon.

One detail: the .help bundle extension is normally reserved for Apple use... [2]


As the PostgreSQL documentation source is written using DocBook[3], the best way
to get it packaged for the Apple Help Viewer would be to:

1. create a "DocBook to Apple Help" XSLT stylesheet for the "Modular DocBook
HTML Stylesheet" [4][5];
2. extend the pgsql-doc SGML Makefile for Apple Help output [6];
3. and submit all of this to the pgsql-doc mailing list [7] for inclusion in the
PostgreSQL source...

Plus... a lot of free/open source software documentation is written using
DocBook, so that would help porting them to MacOS X.


So, if you have any experience in DocBook, XSLT and/or Apple Help authoring,
please be welcome[8]... :-)


Georges Martin,
February 2005


- --
[1]
<http://developer.apple.com/documentation/Carbon/Conceptual/
ProvidingUserAssitAppleHelp/index.html>
[2]
<http://developer.apple.com/documentation/Carbon/Conceptual/
ProvidingUserAssitAppleHelp/registering_help/chapter_4_section_2.html#//
apple_ref/doc/uid/TP30000903-CH207-TPXREF101>
[3] <http://docbook.sourceforge.net/>
[4] <http://docbook.sourceforge.net/projects/xsl/index.html>
[5] there's already a htmlhelp stylesheet for Windows:
<http://docbook.sourceforge.net/release/xsl/current/doc/htmlhelp.html>
[6] <http://developer.postgresql.org/cvsweb.cgi/pgsql/doc/src/sgml/>
[7] <http://archives.postgresql.org/pgsql-docs/>
[8] on the pgsql-doc, docbook-apps
(<http://www.oasis-open.org/docbook/mailinglist/>) and/or apple-help-authoring
(<http://lists.apple.com/mailman/listinfo/apple-help-authoring/>) mailing lists
?

-----BEGIN PGP SIGNATURE-----
Version: PGP SDK 3.2.2

iQA/AwUBQgTWT44kdqHgrM7/EQJP8ACgnCpT4Rb6CDi+XxjeXL7jgmd85SsAn16V
qNkzA5y/PGunFibgfv9R1zrD
=iohN
-----END PGP SIGNATURE-----